Skip to main content

📝 Adding command or argument descriptions

Describe your commands (and optionally nested literals and arguments) with language keys. Players see those descriptions when they hover a command in /help or run /help <command...>.

When you add a command description, Better /help attributes that command to your mod.

Key formats​

{
  "examplemod.commands.examplecommand.description": "Description of your command."
}

Replace examplemod with your mod's id, and examplecommand with your command's name.

Prefer prefixed keys to avoid translation key conflicts between mods.

Plain​

You can omit the mod id prefix, but that is not recommended because of translation key conflicts:

{
  "commands.examplecommand.description": "Description of your command."
}

Replace examplecommand with your command's name.

Nested literals and arguments​

Path segments are Brigadier node names (the same strings you pass to Commands.literal("name") and Commands.argument("name", ...), not what the player types):

{
  "examplemod.commands.examplecommand.targets.description": "Who the command applies to."
}

For example, an EntityArgument registered as Commands.argument("targets", EntityArgument.players()) uses targets in the translation key, not @s, @a, or a player name.

Looking up a deeper path (for example /help examplecommand arg1) can show a more specific description than /help examplecommand alone. Better /help tries the most specific path first, then shorter ones. For /help examplecommand arg1 arg2, it looks up:

  1. commands.examplecommand.arg1.arg2.description
  2. commands.examplecommand.arg1.description
  3. commands.examplecommand.description

If none match, no description is shown.

Examples from Better /help​

{
  "commands.advancement.grant.description": "Grants player advancements.",
  "commands.advancement.grant.targets.everything.description": "Grants all advancements to players.",
  "commands.advancement.grant.targets.only.description": "Grants one specified advancement to players."
}

Here targets is the argument node name. /help advancement grant @a everything and /help advancement grant Player123 everything both resolve to commands.advancement.grant.targets.everything.description.

Argument descriptions